home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / wa_137.zip / SYSOP.TXT < prev    next >
Text File  |  1992-09-26  |  11KB  |  270 lines
  1.  
  2.                    WIZARD'S ARENA -- RELEASE 1.37
  3.              (C) Copyright 1991,1992 by Douglas Summers
  4.  
  5.                          SYSOP DOCUMENTATION
  6.  
  7.  
  8. ────────────
  9. INTRODUCTION
  10. ────────────
  11. To all you new users, thank you for trying out Wizard's Arena.  If
  12. you're not a new user, refer to UPGRADE.TXT for instructions on
  13. upgrading to the new version.
  14.  
  15. The Wizard's Arena is a BBS door game, allowing a  number of players
  16. to wander around in a large maze-like area and fight it out, using a
  17. wide variety of spells and a certain amount of  ironmongery.  Further
  18. details on the setting of the game -- and on actual play -- can be
  19. found in the player's documentation.
  20.  
  21.  
  22. ─────────────────────
  23. BEFORE WE GET STARTED
  24. ─────────────────────
  25. Check your distribution files.  You should have the following :
  26.  
  27.         WIZARD.EXE     -- the game itself
  28.         WA-UTIL.EXE     -- to install and do daily maintenance
  29.  
  30.         WIZARD.TXT     -- the player documentation
  31.         COMMAND.TXT     -- the on-line quick-help file
  32.         CHANGES.TXT     -- a list of the modifications since 1.00
  33.         SYSOP.TXT     -- this documentation
  34.         COPYRIGH.TXT -- the copyright notice for the game, & legal stuff
  35.         UPGRADE.TXT     -- how to upgrade from older versions
  36.         CONFIG.TXT     -- how to customize the game
  37.  
  38.         DATABASE.ZIP -- the initial game databases (see notes, below)
  39.         DOOR.SYS     -- used to run in LOCAL mode
  40.         README.1ST     -- a file that tells you to read this file.
  41.  
  42. There may also be a README.TXT.  If one exists, you should read
  43. it IMMEDIATELY.  If there isn't one, don't worry about it.  There
  44. may also be an ADS.TXT file, which will be a small file describing
  45. other games you might be interested in.  If it's not there, don't
  46. sweat it particularly, either.
  47.  
  48. Other than README.TXT and/or ADS.TXT, if any of these files are
  49. missing or there are 'extra' files, I suggest you delete this
  50. stuff off your disk and get a copy from a 'known clean' source.
  51.  
  52.  
  53. ───────────────────────────
  54. SETTING UP (NEW USERS ONLY)
  55. ───────────────────────────
  56. Just follow these simple instructions:
  57.  
  58.     1.    Make a directory for the game.  For example, D:\WIZARD.
  59.  
  60.     2.    Copy all the distribution files into that directory.
  61.         All the files should remain together; the game looks in its
  62.         own directory for the databases and text files (although
  63.         that directory needn't be the CURRENT directory at the
  64.         time the program is run).
  65.  
  66.     3.    Unzip DATABASE.ZIP.
  67.  
  68.     4.    Set up a batch file to run the program.  See the following
  69.         section for details.
  70.           
  71.     5.    Run WA-UTIL.EXE.  This will generate a small file named
  72.         "CONFIG.WA".  (It will also generate a file named
  73.         "REGISTER.ME" that you will need if you decide to register
  74.         the game.)  You should customize the CONFIG file, at the very
  75.         least to specify your BBS's name.  Please refer to CONFIG.TXT
  76.         for details.
  77.  
  78.  
  79. ───────────────────────── 
  80. SETTING UP THE BATCH FILE
  81. ─────────────────────────
  82. You'll need to make a batch file to call the program with.  The line
  83. actually calls the game can look something like this:
  84.  
  85.     C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  86.  
  87. The directory the game is in doesn't need to be on your path;
  88. of course, your batch file must be.
  89.  
  90. The only parameter to the program is the location (full path-and-
  91. filename) of the door-information file for your BBS.  Different BBS
  92. types use different ones, so if you're not sure how to set this up,
  93. just refer to your BBS documentation.
  94.  
  95. The batch file  should look something like this (this example is for
  96. PCBoard):
  97.  
  98.     C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  99.     board.bat            (or whatever it takes to crank your board back up)
  100.  
  101.  
  102. ──────────────────────
  103. NETWORK CONSIDERATIONS
  104. ──────────────────────
  105. Both programs (WIZARD and WA-UTIL) require complete control of the
  106. database;  two nodes can't be running the program at the same
  107. time.  The programs enforce this by creating a semaphore file and
  108. deleting it when the program terminates.  If the program sees this
  109. file, it simply terminates with a 'Sorry, you can't...' sort of
  110. message.
  111. What happens if the system goes down, or the program locks up?  The
  112. semaphore file remains behind, blocking further access.  For this
  113. reason, the file is time-stamped: a semaphore file more than an
  114. hour old is ignored.
  115. For this reason, it is necessary that each machine's time-of-day
  116. clock be more-or-less in sync with the server's.  Chances are,
  117. you're set up that way already.  If you can't guarantee that,
  118. you should manually perform such semaphoring in your batch file and
  119. set WIZARD's automatic semaphoring off.  (See CONFIG.TXT).
  120.   
  121.  
  122. ───────────────
  123. RUNNING LOCALLY
  124. ───────────────
  125. The game can be run locally simply by calling it directly with a
  126. command-line parameter of "DOOR.SYS".  This causes the game to
  127. use that file (provided with the game) instead of the door-
  128. information file normally employed.  It'll prompt you for a user's
  129. name; any user in the game is available to you.
  130.  
  131.  
  132. ───────────
  133. REGISTERING
  134. ───────────
  135. Registering the game is pretty easy.  After you've run the WA-UTIL
  136. program, there will be a file named "REGISTER.ME" in the directory
  137. with the WIZARD databases.
  138.  
  139. Read it, fill in the few blanks, and mail it to me (the address
  140. is listed on the form itself) with a $15 (US) check or money order
  141. enclosed.  Feel free to use the comment area for kudos or brickbats.
  142.  
  143. After the post office has done its glacial best to lose the letter,
  144. I will return to you (via a postcard) a short sequence of numbers and
  145. some letters (along with my eternal gratitude).  Simply edit your
  146. CONFIG.WA file to have a line in it that says:
  147.  
  148.                 REGISTRATION = XXXXXXXX
  149.      
  150. (where the X's are replaced by the registration sequence I send you).
  151. The game will now 'know' its registered, will be overjoyed to see
  152. that you support a starving shareware artist, and will gleefully
  153. permit the registration-specific parameters to take effect.
  154.  
  155. There aren't any diskettes involved in the registration process;
  156. only a simple code.  In particular, the author doesn't undertake
  157. to distribute newer versions far and wide as they become available.
  158. Announcements on the release of new version are made in appropriate
  159. RIME and InterLink conferences, along with a (short) list of BBS's
  160. that the new version can be downloaded from.
  161.  
  162. Any comments you have about the game are more than welcome,  particularly
  163. if accompanied by cash.  I can be reached via RIME or by mail; my
  164. address is listed in the COPYRIGH.TXT file.
  165.  
  166. Please Note: The key sequence, and therefore the registration sequence,
  167. are based partly on the BBS name you set up in CONFIG.WA.  If you
  168. need to change the name of your board, you'll need a new registration
  169. sequence; contact the author in this event.
  170.  
  171. ───────────────
  172. SYSOP FUNCTIONS
  173. ───────────────
  174. The author is very much indebted to Rickie Belitz for his excellent
  175. CKIT library for the nuts-and-bolts of door handling.  Since I don't
  176. have the source-code to this shareware library, my ability to support
  177. it is limited.  If any problems come up, though, I'll try.  I've culled
  178. a small amount of documentation from his text files, to describe the
  179. features that my program provides via his library.
  180.  
  181. Certain functions are allowed to the sysop while the remote user is
  182. running the door.
  183.  
  184. These (as drawn from his documentation) are:
  185.  
  186.     Function Key
  187.     ────────────
  188.         F5            Shell to DOS
  189.         F8            Return user to system
  190.         F9            Toggle display
  191.         F3            Toggle Printer        (PCBoard only)
  192.         F4            Toggle Bell            (PCBoard only)
  193.         F7            Toggle Caller Alarm    (PCBoard Only)
  194.         Alt-H        Toggle status line
  195.         Alt-N        Toggle sysop on next
  196.         Alt-X        Exit to DOS after call
  197.  
  198.  
  199. ──────────────────
  200. IF ERRORS OCCUR...
  201. ──────────────────
  202. If an error should happen during game-play, the user will be
  203. dumped back to the BBS and a file named ERRORS.OUT will contain
  204. specific information about the error.
  205.  
  206. Try fixing the obvious things -- low RAM, not enough file handles,
  207. and so on.  If you're running on a network, make sure that only
  208. one node at a time can be in the game.  Then try restoring from
  209. the backup that you so    prudently keep.  If the problem persists,
  210. try running the WA-UTIL program; it does a small amount of error-
  211. detection and -correction,    even when it doesn't need to convert
  212. anything.
  213.  
  214. If none of these things work, contact the author.  He'll try to
  215. sort it out.  Please do so via RIME conferences, or the postal
  216. service; he keeps weird hours and ought not be disturbed in his
  217. well-deserved rest.
  218.  
  219. After errors are resolved, you might want to delete (or at least
  220. edit) the error-log, ERRORS.OUT.  The game makes no effort to do so.
  221.  
  222.  
  223. ──────────
  224. BACKING UP
  225. ──────────
  226. If the program bombs, it might be nice to be able to restore from
  227. an archive to a state prior to the error.  Therefore, it'd be
  228. nice to back up the databases from time to time.  
  229. It isn't a good idea to back up EVERY time someone logs in,
  230. though -- much time is wasted.  WIZARD.EXE (and WA-UTIL.EXE, see below)
  231. will exit with an errorlevel of 100 if it does the daily maintenance.
  232.  
  233. You can use this to perform backups on a daily basis. For example:
  234.  
  235.     C:\WIZARD\WIZARD C:\PCB\PCBOARD.SYS
  236.     IF ERRORLEVEL 100 GOTO DAILY
  237.     GOTO NO_BACKUP
  238.     :DAILY
  239.     PKZIP DAILY C:\WIZARD\WA0*.*
  240.     GOTO NO_BACKUP
  241.     :NO_BACKUP
  242.  
  243. The only files that need to be archived are the databases, which
  244. have a filespec "WA*.*".
  245.  
  246.  
  247. ─────────────────
  248. DAILY MAINTENANCE
  249. ─────────────────
  250. The first user to enter the game on a given day triggers the daily
  251. maintenance; this is a process that distributes random monsters and
  252. items, gives everyone their AP/FP allotment and moves the NPCs.
  253.  
  254. It can take from a few seconds to a few minutes, depending on the 
  255. number of NPCs wandering around and the speed of your computer;
  256. you might, therefore, want to do it off-line.
  257.  
  258. To this end, the program WA-UTIL.EXE will run daily maintenance if
  259. there is any need to do so.  It takes the same parameters as
  260. WIZARD.EXE does, but ignores the ones not relating to daily
  261. maintenance.  All it does is run the daily maintenance, if it hasn't
  262. already been run that day (by WA-UTIL.EXE or WIZARD.EXE).
  263.  
  264. I recommend that you simply put a call to it in the 'system event'
  265. stuff (which is often used for getting/processing mail and so forth).
  266. That way, your users will never have to sit through it.
  267.  
  268. Use of WA-UTIL.EXE this way is entirely optional; if it doesn't do
  269. the daily maintenance on schedule, WIZARD.EXE will.
  270.